home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / door / qdmenu10.zip / QDMENU.DOC < prev    next >
Text File  |  1992-10-15  |  23KB  |  713 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.          ╓─╖ ╖ ╓ ╥ ╓─╖ ╥╓─     ╥─╖ ╓─╖ ╓─╖ ╥─╖     ╓─╥─╖ ╥─╖ ╥─╖ ╖ ╓
  15.          ║ ║ ║ ║ ║ ║   ╟╨╖     ║ ║ ║ ║ ║ ║ ╟┬╜     ║ ║ ║ ╟─  ║ ║ ║ ║
  16.          ╙─\ ╙─╜ ╨ ╙─╜ ╨ ╙     ╨─╜ ╙─╜ ╙─╜ ╨ \     ╨   ╨ ╨─╜ ╨ ╨ ╙─╜
  17.  
  18.                                  version 1.0
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.                               by Michael Wilson
  48.  
  49.                                  The Village
  50.                                 408-229-0706
  51.                         USR Courier HST Dual Standard
  52.                             1200/2400/9600/16.8K
  53.                               24 hours / 7 days
  54.  
  55.  
  56.  
  57.  
  58.  
  59.                                 CONTENTS
  60.                                 ════════
  61.  
  62.    I.   Introduction
  63.         a. Overview
  64.         b. Background
  65.         c. Tools
  66.         d. Restrictions in the unregistered version
  67.         e. Benefits of registering
  68.         f. Support
  69.  
  70.    II.  Setup
  71.         a. Supported BBS Systems
  72.         b. Setting up the menu
  73.         c. USE
  74.  
  75.    III. Compufax Software
  76.  
  77.    IV.  Registration Information and Form
  78.  
  79.    V.   Bug report form
  80.  
  81.    VI.  Revision History
  82.  
  83.  
  84.  
  85.  
  86.                               INTRODUCTION
  87.                               ════════════
  88.  
  89. Overview
  90. ────────
  91.  
  92.    QDMENU is a fast, simple and quick to setup door menu for your BBS.  This
  93.    is not for the sysop who wants 100+ doors.  But if you want a simple, 1
  94.    level door menu that uses batch files, this is for you.  Features include:
  95.  
  96.      * Fully configurable - You create the main menu, you write the
  97.        batch files
  98.      * Support for all known and unknown comm ports
  99.      * Fossil driver support
  100.      * Complete monitoring of system time, time left, carrier and DTE
  101.      * Support for color and mono screens
  102.  
  103.  
  104. Background
  105. ──────────
  106.  
  107.    The idea for this menu was originally David Clifford's at the Haunted
  108.    Castle BBS (408) 226-1052.  He needed a simple, single level door menu to
  109.    combine all of his trivia doors in one place.
  110.  
  111.  
  112. Tools
  113. ─────
  114.  
  115.         Language and Compiler:  Borland C 3.1
  116.  
  117.         Editor:                 Multi-Edit 6.00c
  118.  
  119.         Libraries:              CKit Door Library 2.51
  120.  
  121.         Version Control:        Sage's PVCS
  122.  
  123.         Beta Test:              The Haunted Castle BBS (Spitfire)
  124.                                     408-226-1052
  125.                                 The Village (Wildcat)
  126.                                     408-229-0706
  127.  
  128.         Tea:                    Earl Grey, Hot (Bigelow)
  129.  
  130.  
  131.  
  132.  
  133. Restrictions in the unregistered version
  134. ────────────────────────────────────────
  135.  
  136.    This utility is fully functional in the unregistered version.  However,
  137.    there is a pause at the end, when the door is exited, and you cann change
  138.    line 7 in the config file.  You are also limited to 8 doors.
  139.  
  140.  
  141.  
  142. Benefits of registering
  143. ───────────────────────
  144.  
  145.    1. All delays and reminders are removed.
  146.  
  147.    2. A 1 year membership in The Village BBS.
  148.  
  149.    3. All future updates FREE, downloaded from The Village BBS.
  150.  
  151.    4. Ability to change line 7 in the config file.
  152.  
  153.    5. Up to 26 doors can be called
  154.  
  155.  
  156.  
  157. Support
  158. ───────
  159.  
  160.    I will not accept voice phone calls, but can be reached at the following
  161.    locations:
  162.  
  163.    Snail-Mail:  Compufax Consulting Services
  164.                 7145 Aptos Beach Court
  165.                 San Jose, CA  95139
  166.  
  167.    BBS:   The Village
  168.           408-229-0706
  169.           USR Courier HST Dual Standard 16.8
  170.           Leave comment for the SYSOP in the Main Conference [000]
  171.  
  172.    CompuServe:  76207,1673
  173.  
  174.  
  175.    The latest version will always be available on the following boards:
  176.  
  177.         The Village:
  178.                 408-229-0706
  179.                 USR Courier HST Dual Standard 16.8
  180.                 Michael Wilson, sysop
  181.  
  182.         The Haunted Castle BBS:
  183.                 408-226-1052
  184.                 USR Courier HST Dual Standard 14.4
  185.                 David Clifford, sysop
  186.  
  187.         CompuServe:  IBM BBS Forum (GO IBMBBS), Doors Library
  188.  
  189.  
  190.  
  191.                                   SETUP
  192.                                   ═════
  193.  
  194. Supported BBS Systems
  195. ─────────────────────
  196.  
  197.    QDMENU will support any BBS that creates a DOOR.SYS file when
  198.    chaining to a door.  Also, Wildcat 2.x (CALLINFO.BBS) and PC Board - 12.x
  199.    through 14.x (PCBOARD.SYS) are supported.
  200.  
  201. Setting up the Menu
  202. ───────────────────
  203.  
  204.    The way QDMENU works is very simply.  You must create an ANSI and ASCII
  205.    menu, and reference them in your config file.  The menus MUST have letters
  206.    by each of the options.  QDMENU will only accept letters as input.
  207.    QDMENU, when a letter is pressed, exits and sets the system errorlevel to
  208.    to following values:
  209.  
  210.         Errorlevel              Letter
  211.             1                     A
  212.             2                     B
  213.             3                     C
  214.             4                     D
  215.             5                     E
  216.             6                     F
  217.             7                     G
  218.             8                     H
  219.             9                     I
  220.             10                    J
  221.  
  222.                      etc.
  223.  
  224.             128                  Quit or Error
  225.  
  226.  
  227.    So, QDMENU must be called from inside a batch file.  When it exits, test
  228.    the system errorlevel:
  229.  
  230.                 if errorlevel 128 goto END
  231.                 if errorlevel 26 goto door_z
  232.                 etc.
  233.  
  234.    If the errorlevel matches, you will branch to the appropriate area of the
  235.    batch file, and the door will run.  Include a loop back to the start of
  236.    the batch file at the end of each door.
  237.  
  238.    SEE LOCAL.BAT FOR MORE INFORMATION
  239.  
  240.  
  241.  
  242. Flow Chart of QDMENU
  243. ────────────────────
  244.  
  245.       ┌──────────────────┐
  246.       │ Display the menu │
  247.       └────────┬─────────┘
  248.                │
  249.       ┌────────┴─────────┐
  250.       │ Wait for Keypress│
  251.       │ (letters only)   │
  252.       └────────┬─────────┘
  253.                │
  254.                │
  255.       ┌────────┴─────────┐
  256.       │ Exit, setting the│
  257.       │ system errorlevel│
  258.       └──────────────────┘
  259.  
  260.  
  261. The "Nothing Happened" Return
  262. ─────────────────────────────
  263.  
  264.    If the caller dropps carrier, exceeds their time, or pressed 0 to quit,
  265.    then QDMENU will return with an errorlevel of 128.  Therefore, you should
  266.    test for this errorlevel to exit the batch file and return to your board.
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.                                      USE
  280.                                      ═══
  281.  
  282.    Because QDMENU works with batch files, you can have multiple callings of
  283.    QDMENU within your system.  For example, with Wildcat!, you could have
  284.    each letter on the DOORS.BBS menu call a QDMENU batch file.  Or, you could
  285.    have 5 of your most popular doors called right from the main door menu,
  286.    but then have 3 or 4 QDMENUS called with the other door menus.
  287.  
  288.    You could also attach QDMENU to a DOS HOOK.  For example, lets suppose
  289.    that you want a menu of file utilities on the file menu.  Make your
  290.    FILE1.BAT file a QDMENU batch file.
  291.  
  292.    The uses for QDMENU are unlimited.  Adding more options to your menus and
  293.    doors, while giving you full customization and control over everything.
  294.    You use your favorite drawing program and editor to create the menu and
  295.    batch file.  What could be easier?
  296.  
  297.    As a final note, you can even have QDMENU call another QDMENU batch file
  298.    to make QDMENU a multiple level menu system.
  299.  
  300.  
  301.  
  302.                              CONFIGURATION FILE
  303.                              ══════════════════
  304.  
  305.    LINE 1: c:\wc30\wcwork\node1\door.sys
  306.    LINE 2: The Village
  307.    LINE 3: Michael Wilson
  308.    LINE 4: 0000000000
  309.    LINE 5: main
  310.    LINE 6: 5
  311.   *LINE 7: Well, here we go...wish the sysop would register
  312.    LINE 8: NONE
  313.  
  314.    *These items cannot be changed in the UNREGISTERED version.
  315.  
  316.    LINE 1: This is the complete drive letter, path and filename of your
  317.            BBS door system file.  This can be either DOOR.SYS,
  318.            CALLINFO.BBS or PCBOARD.SYS.
  319.  
  320.    LINE 2: This is the name of your BBS.  It must EXACTLY match the name
  321.            of the BBS you put on the registration form.  Upper and lower
  322.            case make a difference here.  This name will be displayed
  323.            EXACTLY as entered here when the door is registered.
  324.  
  325.    LINE 3: This is the name of the sysop.  This name must EXACTLY match
  326.            the name entered on the registration form.  Upper and lower
  327.            case make a difference.  This name will be displayed as the
  328.            sysop when the door is registered.
  329.  
  330.    LINE 4: The registration number obtained when you register.
  331.  
  332.    LINE 5: The complete path and root filename of your main menu.  Do not
  333.            include and extension.  2 files must exist with this root file
  334.            name.  .SCR and .BBS will be displayed depending on the callers
  335.            ANSI graphics setting.  .SCR will be displayed if the caller has
  336.            ANSI graphics on, .BBS will be sent of not.  Therefore, if your
  337.            root file name was MAIN, you would need a MAIN.SCR and a MAIN.BBS
  338.  
  339.    LINE 6: This is the number of entries on the main menu.
  340.  
  341.    LINE 7: This is the line of text displayed to the caller right before
  342.            running the selected door.
  343.  
  344.    LINE 8: This line of for  non-standard comm port parameters.  If  you do
  345.            not  use  a  standard  comm  port  setup,  then  the  syntax  is
  346.            PORT:AAAA:X where  AAAA is  the base  address and  X is the IRQ.
  347.            FOODFITE  will  also  support  the  use  of FOSSIL drivers.  The
  348.            syntax for a FOSSIL driver is: PORT:F:P. The 'F' tells  FOODFITE
  349.            to  use  a  Fossil  driver  for  it's  communications.   The 'P'
  350.            following  it  tells  it  which  port  to  use  for  the Fossil.
  351.            Example - PORT:F:1,  tells FOODFITE to  use a fossil  driver for
  352.            port 1.  If you use  a standard port setup, place the  word NONE
  353.            here.
  354.  
  355.  
  356.  
  357.  
  358. Sample Door Batch File
  359. ──────────────────────
  360.  
  361.    The configuration filename is placed on the command line of
  362.    QDMENU.EXE.  Here is a sample batch file to give you an idea of how
  363.    the door is called:
  364.  
  365.           C:
  366.           CD\QDMENU
  367.           QDMENU QDMENU.CFG
  368.           CD\
  369.  
  370.    If the configuration file is missing, or incorrectly made, an error
  371.    will be displayed.
  372.  
  373. Local Mode
  374. ──────────
  375.  
  376.    The door can be tested in Local Mode by having the config file point to
  377.    a BBS door file that has a comm port of zero (COM0:).  Included are the
  378.    following files:
  379.  
  380.         LOCAL.BAT
  381.         QDMENU.CFG
  382.         DOOR.SYS
  383.  
  384.    These will assist you in testing the door in local mode.  If you want your
  385.    name displayed instead of "SYSOP", edit DOOR.SYS and replace the word
  386.    SYSOP with your name.
  387.  
  388.    Simply typing LOCAL with the above files in the current directory,
  389.    therefore, will put the door in local mode.
  390.  
  391.  
  392.  
  393.                              MULTI-NODE SUPPORT
  394.                              ══════════════════
  395.  
  396.    QDMENU fully supports multiple nodes.  The only thing you need to do is
  397.    create a different config file for each node.  This is because the
  398.    door.sys file is usually created in a different subdirectory for each
  399.    node.
  400.  
  401.    Your batch file might look somthing like this:
  402.  
  403.         QDMENU QDMENU1.CFG
  404.  
  405.    for node 1.  Most BBS systems have an environment variable that you can
  406.    use to substitute for the node number.
  407.  
  408.    For Wildcat!, on my BBS, I use the following line:
  409.  
  410.         QDMENU QDMENU%WCNODEID%.cfg
  411.  
  412.  
  413.  
  414.  
  415. On-Line Sysop Commands
  416. ──────────────────────
  417.  
  418.    While a caller is on-line, the local sysop has several options.  They are
  419.    as follows:
  420.  
  421.              Function key
  422.              ------------
  423.                 F5              Shell to DOS
  424.                 F8              Return user to system
  425.                 F9              Toggle display on/off
  426.                 F10             Chat mode  (use the ESCAPE key to exit)
  427.               * F3              Toggle printer on/off
  428.               * F4              Toggle pagebell on/off
  429.               * F7              Toggle caller alarm on/off
  430.  
  431.              Alternate key
  432.              -------------
  433.                ALT-H            Toggle between different status lines
  434.  
  435.              * ALT-N            Toggle sysop on next
  436.              * ALT-X            Toggle exit to dos after call
  437.                                 and help lines
  438.  
  439.         Alternately pressing the ALT-H key will bring up
  440.         the next status line screen.  The 1st screen is a help screen,
  441.         the second screen shows your COM port status.
  442.  
  443.  * The function keys marked with an "*"  will only be of use to systems
  444.    using pcboard.sys.  The rest are functional with any system.
  445.  
  446.  
  447.  
  448.                               COMPUFAX SOFTWARE
  449.                               ═════════════════
  450.  
  451.    Compufax  Software  is  a  division  of  Compufax  Consulting Services.  We
  452.    specialize in getting the right computer and software for your needs.   All
  453.    of our work is custom and created just for you.
  454.  
  455.    We  started  writing  door  software  with  a program called BUY&SELL Door.
  456.    After reviewing dozens  of For Sale  Doors, we could  not find one  to meet
  457.    our needs,  so we  wrote one.   That is  what we  do.   We find a need, and
  458.    write a door to fill  that.  You won't find  us writing 30 card game  doors
  459.    that all  look the  same.   Each door  is individually  designed to  meet a
  460.    need.  Currently, we have 3 BBS door programs:
  461.  
  462.         Food Fight
  463.         Buy & Sell
  464.         UNIPAGE
  465.         QDMENU
  466.  
  467.    We will not cripple  our doors.  We'll  just put in a  few seconds reminder
  468.    that this copy is unregistered.   We will never write a door  that expires.
  469.    We have  over 60  doors on  our board,  and sometimes  it is month before a
  470.    door is fully tested.  We won't force you to download a demo key every  few
  471.    weeks either.   Everything you  need for  full operation  of our  doors  is
  472.    included in  the distribution  zip.   No runtime  modules, no keys, nothing
  473.    extra, nothing more to download.
  474.  
  475.    All of our doors have a simple to use Local mode.  You can see the  program
  476.    before you put it online.
  477.  
  478.    Your registrations are  forever.  When  we give you  a registration number,
  479.    you will never need to buy anything ever again.  Each new version will  use
  480.    the same number, and you're registered for life.
  481.  
  482.    You can receive  free technical support  even if you  are not a  registered
  483.    user.  Because  of my schedule,  I cannot be  available for voice  support,
  484.    but I'll answer  every message on  my BBS and  Compuserve.  If  you need to
  485.    talk to me voice, I'll be happy to make an appointment and call you.
  486.  
  487.    We're tired of poorly programmed, boring BBS Doors.  We are here to  change
  488.    all that.  We may not have 30 doors, but the few we have are the best!
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.                                 REGISTRATION
  506.                                 ════════════
  507.  
  508.      When you register QDMENU, your registration number will be posted on The
  509.      Village BBS (408-229-0706), in a private message to you.  You should
  510.      allow 1 week from the time you send your check before the message is
  511.      posted.  Other options include sending you the number and sending you
  512.      the latest version of the program with the number.  NOTE: The latest
  513.      version may not be later than the one you have, and no version number
  514.      verification will be performed..
  515.  
  516.  
  517.  
  518.  
  519.  
  520.                         QDMENU REGISTRATION FORM
  521.                         ════════════════════════
  522.  
  523.      Your BBS Number (so I can call and see):________________
  524.  
  525.  
  526.      Name: ___________________________________________________
  527.  
  528.            (Your name here must match EXACTLY with the name entered
  529.             on line 3 of the config file.  Upper and lower case make a
  530.             difference here.  Print or type clearly.)
  531.  
  532.  
  533.      BBS Name: _______________________________________________
  534.  
  535.                (Your BBS name here must match EXACTLY with the BBS name
  536.                entered on line 2 of the config file.  Upper and lower case
  537.                make a difference here.  Print or type clearly.)
  538.  
  539.  
  540.      The name you have used or wish to use to log into The Village BBS:
  541.  
  542.      _________________________________________________________________
  543.  
  544.  
  545.       ╔════════════════════════════════════════════════════════════╗
  546.       ║                                                            ║
  547.       ║ If you do not have a login to my board, and wish me to set ║
  548.       ║ one up for you, supply the following information:          ║
  549.       ║                                                            ║
  550.       ║                                                            ║
  551.       ║ Phone number (with area code): __________________________  ║
  552.       ║                                                            ║
  553.       ║ Birthday: _______________________________________________  ║
  554.       ║                                                            ║
  555.       ║ Password: _______________________________________________  ║
  556.       ║                                                            ║
  557.       ╚════════════════════════════════════════════════════════════╝
  558.  
  559.  
  560.      If you wish me to send you the registration number of the latest
  561.      version of QDMENU, fill out the following:
  562.  
  563.  
  564.      Address:____________________________________________________
  565.  
  566.              ____________________________________________________
  567.  
  568.              ____________________________________________________
  569.  
  570.  
  571.  
  572.      Mail To:  Compufax Consulting Services
  573.                7145 Aptos Beach Court
  574.                San Jose, CA  95139
  575.  
  576.      Select which option you would like to register QDMENU:
  577.  
  578.      Basic Registration.
  579.        Includes lifetime registration number posted
  580.        to The Village BBS in a private message to you....$10.00 _____
  581.  
  582.      Mail Number.
  583.        Includes lifetime registration number mailed
  584.        to you at the above address.......................$12.50 _____
  585.  
  586.      Mail Diskette.
  587.        Includes lifetime registration number mailed
  588.        to on a diskette, along with the latest version
  589.        of this software..................................$17.00 _____
  590.  
  591.  
  592.  *** Special deal.  Get $5.00 off QDMENU if you have already registered
  593.      another Compufax Software Product.
  594.  
  595.           Type of diskette: *5.25" High Density _____
  596.                              5.25" Low Density  _____
  597.                             *3.5"  High Density _____
  598.                              3.5"  Low Density  _____
  599.  
  600.         *If you choose a High Denisty diskette, you will get
  601.          sample of other compufax Software on the same disk
  602.  
  603.                                            Total Enclosed: __________
  604.       Payment method:
  605.  
  606.       [  ] Check made payable to Compufax Consulting Services.
  607.  
  608.       [  ] VISA   [  ] Master Card   [  ] Discover   [  ] Carte Blanche
  609.  
  610.       [  ] JCB    [  ] Diner's Club
  611.  
  612.  
  613.     For Credit Card Purchases:
  614.  
  615.       Number:________________________________Ex Date:_________________
  616.  
  617.       Name on card:___________________________________________________
  618.  
  619.       Statement ______________________________________________________
  620.         Mailing
  621.         Address:______________________________________________________
  622.  
  623.                 ______________________________________________________
  624.  
  625.       Home Phone:_____________________ Work Phone:____________________
  626.  
  627.  
  628.       Signature:______________________________________________________
  629.  
  630.  
  631.  
  632.                         R E G I S T E R   O N L I N E
  633.                         ═════════════════════════════
  634.  
  635.     You can register this software On-Line on the Village BBS.  From the main
  636.     menu, Choose [Q]uestionnaires, and choose questionnaire number 6.  Have
  637.     your charge card ready.
  638.  
  639.     We accept VISA, Master Card, Discover, Diner's Club, Carte Blanche and
  640.     JCB cards.
  641.  
  642.     Due to the nature of your purchase, your registration number will be
  643.     available within 12 hours of you completing the questionnaire.
  644.  
  645.  
  646.  
  647.                                  BUG REPORT
  648.                                  ══════════
  649.  
  650.     Please report any and all bugs to my.  Include as much information as you
  651.     can.  If I think I have fixed it, I will send you the new version
  652.     for free, for testing.
  653.  
  654.     You may use the form below to report any bugs, or use your own form.
  655.     Please send the form to me, or upload it to my BBS.
  656.  
  657.     Explain the bug:____________________________________________________
  658.  
  659.     ____________________________________________________________________
  660.  
  661.     ____________________________________________________________________
  662.  
  663.     ____________________________________________________________________
  664.  
  665.     ____________________________________________________________________
  666.  
  667.     ____________________________________________________________________
  668.  
  669.     ____________________________________________________________________
  670.  
  671.     ____________________________________________________________________
  672.  
  673.     ____________________________________________________________________
  674.  
  675.     ____________________________________________________________________
  676.  
  677.     ____________________________________________________________________
  678.  
  679.     ____________________________________________________________________
  680.  
  681.     ____________________________________________________________________
  682.  
  683.     (use another sheet of paper if needed)
  684.  
  685.     Your BBS number:____________________________________________________
  686.  
  687.     Version of QDMENU:__________________________________________________
  688.  
  689.     DOS Date and time of QDMENU.EXE:____________________________________
  690.  
  691.     BBS Software and version:___________________________________________
  692.  
  693.     Describe your machine:______________________________________________
  694.  
  695.     ____________________________________________________________________
  696.  
  697.     Describe your multi-tasking, if any:________________________________
  698.  
  699.     ____________________________________________________________________
  700.  
  701.     Is this multi-node? (how many)______________________________________
  702.  
  703.  
  704.  
  705.                               REVISION HISTORY
  706.                               ════════════════
  707.  
  708.     October 15, 1992   Version 1.0
  709.         Initial Release
  710.  
  711.  
  712.  
  713.